Skip to content

docs: condense get started fast section#504

Merged
Mossaka merged 4 commits intomainfrom
copilot/unbloat-readme-get-started
Feb 4, 2026
Merged

docs: condense get started fast section#504
Mossaka merged 4 commits intomainfrom
copilot/unbloat-readme-get-started

Conversation

Copy link
Contributor

Copilot AI commented Feb 4, 2026

Reduce README bloat by keeping “Get started fast” terse while still showing installation and a minimal usage example.

  • README cleanup
    • Keep a two-line quick start (install + basic awf usage) and add a one-sentence note explaining the -- separator.
curl -sSL https://raw.githubusercontent.com/github/gh-aw-firewall/main/install.sh | sudo bash
sudo awf --allow-domains github.com -- curl https://api.github.com

The -- separator divides firewall options from the command to run.

README get started fast section update

Custom agent used: technical-doc-writer
AI technical documentation writer for awf library using Astro Starlight

Original prompt

unbloat the readme, get started fast section should just be one line to get started. no more than that

Custom agent used: technical-doc-writer
AI technical documentation writer for awf library using Astro Starlight


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com>
Copilot AI changed the title [WIP] Refactor 'Get Started Fast' section of README docs: condense get started fast section Feb 4, 2026
Copilot AI requested a review from Mossaka February 4, 2026 00:36
Copy link
Collaborator

@Mossaka Mossaka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review: REQUEST_CHANGES

@copilot Please fix the following issues:

Problem

The "Get started fast" section now only shows installation but removes the usage example entirely. A "Get started fast" section that only shows how to install - but not how to USE - the tool defeats its purpose.

What was removed that should be kept:

  • The example command showing how to actually run awf after installation
  • The explanation about the -- separator (critical syntax)

Required Fix

Keep at least one usage example. A minimal but complete version:

## Get started fast

```bash
curl -sSL https://raw.githubusercontent.com/github/gh-aw-firewall/main/install.sh | sudo bash
sudo awf --allow-domains github.com -- curl https://api.github.com

This keeps it terse (two lines) while showing both installation AND basic usage.

The prerequisite note about Docker can optionally be removed, but the usage example is essential.

Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Feb 4, 2026

Review: REQUEST_CHANGES

@copilot Please fix the following issues:...

Added a minimal usage example and a one-sentence -- separator note to the Get started fast section. Screenshot: https://github.com/user-attachments/assets/7db60ed1-c454-4607-b26c-9e26477e6792. Commit: 5b0fd21.

Copilot AI requested a review from Mossaka February 4, 2026 17:12
@github-actions
Copy link
Contributor

github-actions bot commented Feb 4, 2026

🎬 THE ENDSmoke Claude MISSION: ACCOMPLISHED! The hero saves the day! ✨

@github-actions
Copy link
Contributor

github-actions bot commented Feb 4, 2026

📰 VERDICT: Smoke Copilot has concluded. All systems operational. This is a developing story. 🎤

@github-actions
Copy link
Contributor

github-actions bot commented Feb 4, 2026

Smoke Test Results

Last 2 Merged PRs:

Tests:

  • ✅ GitHub MCP (fetched PR data)
  • ✅ Playwright (page title: "GitHub · Change is constant. GitHub keeps you ahead. · GitHub")
  • ✅ File writing (smoke-test-copilot-21686290075.txt)
  • ✅ Bash tool (file verified)

Overall: PASS

cc @Mossaka

AI generated by Smoke Copilot

@github-actions
Copy link
Contributor

github-actions bot commented Feb 4, 2026

Smoke Test Results for Claude Engine

Last 2 merged PRs:

✅ GitHub MCP: Retrieved PR data
✅ Playwright: Navigated to GitHub, title verified
✅ File Write: Created test file successfully
✅ Bash Tool: Verified file contents

Overall Status: PASS

AI generated by Smoke Claude

@Mossaka Mossaka marked this pull request as ready for review February 4, 2026 20:14
Copilot AI review requested due to automatic review settings February 4, 2026 20:14
@Mossaka Mossaka merged commit 4ed3b2b into main Feb 4, 2026
28 checks passed
@Mossaka Mossaka deleted the copilot/unbloat-readme-get-started branch February 4, 2026 20:14
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR condenses the "Get started fast" section of the README to reduce verbosity while maintaining essential information. The update removes the bullet-point structure and Docker prerequisite reminder in favor of a minimal two-command code block with a brief explanation.

Changes:

  • Simplified "Get started fast" section from structured bullets (Prerequisite/Install/Run) to a single code block with two commands
  • Refined the -- separator explanation to be more technically precise ("divides firewall options from the command to run" instead of "passes the command you want to run behind the firewall")

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants